Skip to content

Commit 2cd49a2

Browse files
dga711amaitland
authored andcommitted
Add some xml documentation (#1643)
* add some xml doc * add missing drag xml doc * xml doc corrections * more xml doc
1 parent 8b5d0df commit 2cd49a2

21 files changed

+125
-4
lines changed

CefSharp/AddressChangedEventArgs.cs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,11 @@ public class AddressChangedEventArgs : EventArgs
1414
public IBrowser Browser { get; set; }
1515
public string Address { get; private set; }
1616

17+
/// <summary>
18+
/// Called when a frame's address has changed.
19+
/// </summary>
20+
/// <param name="browser">the browser object</param>
21+
/// <param name="address">the address</param>
1722
public AddressChangedEventArgs(IBrowser browser, string address)
1823
{
1924
Browser = browser;

CefSharp/CEFCursorType.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+
/// Cursor type values.
9+
/// </summary>
710
public enum CefCursorType
811
{
912
Pointer = 0,

CefSharp/CefJsDialogType.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+
/// Supported JavaScript dialog types.
9+
/// </summary>
710
public enum CefJsDialogType
811
{
912
Alert = 0,

CefSharp/CefReturnValue.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+
/// Return value types.
9+
/// </summary>
710
public enum CefReturnValue
811
{
912
/// <summary>

CefSharp/CefState.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+
/// Represents the state of a setting.
9+
/// </summary>
710
public enum CefState
811
{
912
/// <summary>

CefSharp/DefaultResourceHandlerFactory.cs

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,22 @@ public virtual bool UnregisterHandler(string url)
3434
return Handlers.TryRemove(url, out handler);
3535
}
3636

37+
/// <summary>
38+
/// Are there any <see cref="ResourceHandler"/>'s registered?
39+
/// </summary>
3740
public bool HasHandlers
3841
{
3942
get { return Handlers.Count > 0; }
4043
}
4144

45+
/// <summary>
46+
/// Called before a resource is loaded. To specify a handler for the resource return a <see cref="ResourceHandler"/> object
47+
/// </summary>
48+
/// <param name="browserControl">The browser UI control</param>
49+
/// <param name="browser">the browser object</param>
50+
/// <param name="frame">the frame object</param>
51+
/// <param name="request">the request object - cannot be modified in this callback</param>
52+
/// <returns>To allow the resource to load normally return NULL otherwise return an instance of ResourceHandler with a valid stream</returns>
4253
public virtual IResourceHandler GetResourceHandler(IWebBrowser browserControl, IBrowser browser, IFrame frame, IRequest request)
4354
{
4455
try

CefSharp/DragOperationsMask.cs

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

88
namespace CefSharp
99
{
10+
/// <summary>
11+
/// "Verb" of a drag-and-drop operation as negotiated between the source and destination.
12+
/// </summary>
1013
[Flags]
1114
public enum DragOperationsMask : uint
1215
{

CefSharp/DraggableRegion.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+
/// Representing a draggable region.
9+
/// </summary>
710
public struct DraggableRegion
811
{
912
public int Width { get; private set; }

CefSharp/IBrowserHost.cs

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,16 +32,31 @@ public interface IBrowserHost : IDisposable
3232
/// </summary>
3333
void CloseDevTools();
3434

35+
/// <summary>
36+
/// Call this method when the user drags the mouse into the web view (before calling <see cref="DragTargetDragOver"/>/<see cref="DragTargetDragLeave"/>/<see cref="DragTargetDragDrop"/>).
37+
/// </summary>
3538
void DragTargetDragEnter(IDragData dragData, MouseEvent mouseEvent, DragOperationsMask allowedOperations);
3639

40+
/// <summary>
41+
/// Call this method each time the mouse is moved across the web view during a drag operation (after calling <see cref="DragTargetDragEnter"/> and before calling <see cref="DragTargetDragLeave"/>/<see cref="DragTargetDragDrop"/>).
42+
/// This method is only used when window rendering is disabled.
43+
/// </summary>
3744
void DragTargetDragOver(MouseEvent mouseEvent, DragOperationsMask allowedOperations);
3845

46+
/// <summary>
47+
/// Call this method when the user completes the drag operation by dropping the object onto the web view (after calling <see cref="DragTargetDragEnter"/>).
48+
/// The object being dropped is <see cref="IDragData"/>, given as an argument to the previous <see cref="DragTargetDragEnter"/> call.
49+
/// This method is only used when window rendering is disabled.
50+
/// </summary>
3951
void DragTargetDragDrop(MouseEvent mouseEvent);
4052

4153
void DragSourceEndedAt(int x, int y, DragOperationsMask op);
4254

55+
/// <summary>
56+
/// Call this method when the user drags the mouse out of the web view (after calling <see cref="DragTargetDragEnter"/>). This method is only used when window rendering is disabled.
57+
/// </summary>
4358
void DragTargetDragLeave();
44-
59+
4560
void DragSourceSystemDragEnded();
4661

4762
/// <summary>

CefSharp/ICookieVisitor.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+
/// Interface to implement for visiting cookie values.
9+
/// The methods of this class will always be called on the IO thread.
10+
/// </summary>
711
public interface ICookieVisitor
812
{
913
bool Visit(Cookie cookie, int count, int total, ref bool deleteCookie);

0 commit comments

Comments
 (0)