Skip to content

Commit 36fa452

Browse files
committed
Xml Doc improvements
1 parent d4d1286 commit 36fa452

File tree

3 files changed

+45
-2
lines changed

3 files changed

+45
-2
lines changed

CefSharp.WinForms/ChromiumWebBrowser.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -376,7 +376,7 @@ public IRequestContext RequestContext
376376
/// <summary>
377377
/// ParentFormMessageInterceptor hooks the Form handle and forwards
378378
/// the move/active messages to the browser, the default is true
379-
/// and should only be required when using <see cref="CefSettings.MultiThreadedMessageLoop"/>
379+
/// and should only be required when using <see cref="AbstractCefSettings.MultiThreadedMessageLoop"/>
380380
/// set to true.
381381
/// </summary>
382382
[Browsable(false), DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden), DefaultValue(true)]
@@ -619,7 +619,7 @@ protected override void OnHandleCreated(EventArgs e)
619619
/// To re-enable Window Activation then remove WS_EX_NOACTIVATE from ExStyle
620620
/// <code>
621621
/// const uint WS_EX_NOACTIVATE = 0x08000000;
622-
/// windowInfo.ExStyle &= ~WS_EX_NOACTIVATE;
622+
/// windowInfo.ExStyle &amp;= ~WS_EX_NOACTIVATE;
623623
///</code>
624624
/// </example>
625625
protected virtual IWindowInfo CreateBrowserWindowInfo(IntPtr handle)

CefSharp.Wpf/ChromiumWebBrowser.cs

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,14 @@ namespace CefSharp.Wpf
3636
[TemplatePart(Name = PartPopupImageName, Type = typeof(Image))]
3737
public class ChromiumWebBrowser : Control, IRenderWebBrowser, IWpfWebBrowser
3838
{
39+
/// <summary>
40+
/// TemplatePart Name constant for the Image used to represent the browser
41+
/// </summary>
3942
public const string PartImageName = "PART_image";
43+
/// <summary>
44+
/// TemplatePart Name constant for the Image used to represent the popup
45+
/// overlayed on the browser
46+
/// </summary>
4047
public const string PartPopupImageName = "PART_popupImage";
4148

4249
/// <summary>
@@ -1981,6 +1988,13 @@ internal void UiThreadRunAsync(Action action, DispatcherPriority priority = Disp
19811988
}
19821989
}
19831990

1991+
/// <summary>
1992+
/// Run the Action on the CEF UI Thread in an async fashion
1993+
/// </summary>
1994+
/// <param name="action">The action.</param>
1995+
/// <returns>
1996+
/// An asynchronous result.
1997+
/// </returns>
19841998
protected async Task CefUiThreadRunAsync(Action action)
19851999
{
19862000
if (!IsDisposed && InternalIsBrowserInitialized())
@@ -2471,6 +2485,11 @@ protected override void OnMouseLeave(MouseEventArgs e)
24712485
base.OnMouseLeave(e);
24722486
}
24732487

2488+
/// <summary>
2489+
/// Invoked when an unhandled <see cref="E:System.Windows.Input.Mouse.LostMouseCapture" /> attached event reaches an element in
2490+
/// its route that is derived from this class. Implement this method to add class handling for this event.
2491+
/// </summary>
2492+
/// <param name="e">The <see cref="T:System.Windows.Input.MouseEventArgs" /> that contains event data.</param>
24742493
protected override void OnLostMouseCapture(MouseEventArgs e)
24752494
{
24762495
if (!e.Handled && browser != null)

CefSharp.Wpf/Experimental/WpfIMEKeyboardHandler.cs

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,10 @@
1515

1616
namespace CefSharp.Wpf.Experimental
1717
{
18+
/// <summary>
19+
/// A WPF Keyboard handler implementation that supports IME
20+
/// </summary>
21+
/// <seealso cref="T:CefSharp.Wpf.Internals.WpfKeyboardHandler"/>
1822
public class WpfImeKeyboardHandler : WpfKeyboardHandler
1923
{
2024
private int languageCodeId;
@@ -27,10 +31,19 @@ public class WpfImeKeyboardHandler : WpfKeyboardHandler
2731
private MouseButtonEventHandler mouseDownEventHandler;
2832
private bool isActive;
2933

34+
/// <summary>
35+
/// Constructor.
36+
/// </summary>
37+
/// <param name="owner">The owner.</param>
3038
public WpfImeKeyboardHandler(ChromiumWebBrowser owner) : base(owner)
3139
{
3240
}
3341

42+
/// <summary>
43+
/// Change composition range.
44+
/// </summary>
45+
/// <param name="selectionRange">The selection range.</param>
46+
/// <param name="characterBounds">The character bounds.</param>
3447
public void ChangeCompositionRange(Range selectionRange, Rect[] characterBounds)
3548
{
3649
if (!isActive)
@@ -70,6 +83,10 @@ public void ChangeCompositionRange(Range selectionRange, Rect[] characterBounds)
7083
});
7184
}
7285

86+
/// <summary>
87+
/// Setup the Ime Keyboard Handler specific hooks and events
88+
/// </summary>
89+
/// <param name="source">HwndSource.</param>
7390
public override void Setup(HwndSource source)
7491
{
7592
if (isSetup)
@@ -98,6 +115,9 @@ public override void Setup(HwndSource source)
98115
}
99116
}
100117

118+
/// <summary>
119+
/// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
120+
/// </summary>
101121
public override void Dispose()
102122
{
103123
// Note Setup can be run after disposing, to "reset" this instance
@@ -245,6 +265,10 @@ private void OnImeComposition(IntPtr hwnd, int lParam)
245265
}
246266
}
247267

268+
/// <summary>
269+
/// Cancel composition.
270+
/// </summary>
271+
/// <param name="hwnd">The hwnd.</param>
248272
public void CancelComposition(IntPtr hwnd)
249273
{
250274
owner.GetBrowserHost().ImeCancelComposition();

0 commit comments

Comments
 (0)