Skip to content

Commit 2d72e1f

Browse files
committed
Add more xml doc
1 parent 9db72f1 commit 2d72e1f

11 files changed

+48
-3
lines changed

CefSharp/IDownloadHandler.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@
44

55
namespace CefSharp
66
{
7+
/// <summary>
8+
/// Class used to handle file downloads.
9+
/// The methods of this class will called on the CEF UI thread.
10+
/// </summary>
711
public interface IDownloadHandler
812
{
913
/// <summary>

CefSharp/IFocusHandler.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@
44

55
namespace CefSharp
66
{
7+
/// <summary>
8+
/// Implement this interface to handle events related to focus.
9+
/// The methods of this class will be called on the CEF UI thread.
10+
/// </summary>
711
public interface IFocusHandler
812
{
913
/// <summary>

CefSharp/IJsDialogHandler.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@
44

55
namespace CefSharp
66
{
7+
/// <summary>
8+
/// Implement this interface to handle events related to JavaScript dialogs.
9+
/// The methods of this class will be called on the CEF UI thread.
10+
/// </summary>
711
public interface IJsDialogHandler
812
{
913
/// <summary>

CefSharp/IKeyboardHandler.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44

55
namespace CefSharp
66
{
7+
/// <summary>
8+
/// Implement this interface to handle events related to keyboard input.
9+
/// </summary>
710
public interface IKeyboardHandler
811
{
912
/// <summary>

CefSharp/ILifeSpanHandler.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@
44

55
namespace CefSharp
66
{
7+
/// <summary>
8+
/// Implement this interface to handle events related to browser life span.
9+
/// The methods of this class will be called on the CEF UI thread unless otherwise indicated.
10+
/// </summary>
711
public interface ILifeSpanHandler
812
{
913
/// <summary>

CefSharp/IMenuModel.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ public interface IMenuModel
6666
/// </summary>
6767
/// <param name="commandId">the command Id</param>
6868
/// <param name="label">the label of the item</param>
69+
/// <param name="groupId">the group id</param>
6970
/// <returns>Returns true on success.</returns>
7071
bool AddRadioItem(CefMenuCommand commandId, string label, int groupId);
7172

CefSharp/IPluginHandler.cs

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,19 @@
44

55
namespace CefSharp
66
{
7+
/// <summary>
8+
/// Implement this interface to cancel loading of specific plugins
9+
/// </summary>
710
public interface IPluginHandler
811
{
912
/// <summary>
10-
/// Called on the browser process IO thread before a plugin instance is loaded.
13+
/// Called on the CEF IO thread before a plugin instance is loaded.
1114
/// The default plugin policy can be set at runtime using the `--plugin-policy=[allow|detect|block]` command-line flag.
1215
/// </summary>
1316
/// <param name="mimeType">is the mime type of the plugin that will be loaded</param>
1417
/// <param name="url">is the content URL that the plugin will load and may be empty</param>
1518
/// <param name="topOriginUrl">is the URL for the top-level frame that contains the plugin</param>
16-
/// <param name="info">includes additional information about the plugin that will be loaded</param>
19+
/// <param name="pluginInfo">includes additional information about the plugin that will be loaded</param>
1720
/// <param name="pluginPolicy">Modify and return true to change the policy.</param>
1821
/// <returns>Return false to use the recommended policy. Modify and return true to change the policy.</returns>
1922
bool OnBeforePluginLoad(string mimeType, string url, string topOriginUrl, WebPluginInfo pluginInfo, ref PluginPolicy pluginPolicy);

CefSharp/IPrintToPdfCallback.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
namespace CefSharp
88
{
99
/// <summary>
10-
/// Callback interface for <see cref="IBrowserHost.PrintToPDF"/>. The methods of this interface
10+
/// Callback interface for <see cref="IBrowserHost.PrintToPdf"/>. The methods of this interface
1111
/// will be called on the CEF UI thread.
1212
/// </summary>
1313
public interface IPrintToPdfCallback : IDisposable

CefSharp/IRequestContext.cs

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,17 @@
88

99
namespace CefSharp
1010
{
11+
/// <summary>
12+
/// A request context provides request handling for a set of related browser or URL request objects.
13+
/// A request context can be specified when creating a new browser by setting the
14+
/// <see cref="IWebBrowser.RequestContext"/> property (Passing in via the constructor for the OffScreen
15+
/// control is preferred).
16+
/// Browser objects with different request contexts will never be hosted in the same render process.
17+
/// Browser objects with the same request context may or may not be hosted in the same render process
18+
/// depending on the process model.Browser objects created indirectly via the JavaScript window.open
19+
/// function or targeted links will share the same render process and the same request context as
20+
/// the source browser.
21+
/// </summary>
1122
public interface IRequestContext : IDisposable
1223
{
1324
/// <summary>

CefSharp/IRequestHandler.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@
66

77
namespace CefSharp
88
{
9+
/// <summary>
10+
/// Implement this interface to handle events related to browser requests.
11+
/// The methods of this class will be called on the thread indicated.
12+
/// </summary>
913
public interface IRequestHandler
1014
{
1115
/// <summary>

0 commit comments

Comments
 (0)