Skip to content

Commit 511bbf7

Browse files
committed
xml doc improvements
1 parent ee8de7e commit 511bbf7

File tree

5 files changed

+272
-203
lines changed

5 files changed

+272
-203
lines changed

CefSharp/IBrowser.cs

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -44,15 +44,15 @@ public interface IBrowser : IDisposable
4444
bool IsLoading { get; }
4545

4646
/// <summary>
47-
/// Request that the browser close. The JavaScript 'onbeforeunload' event will
48-
/// be fired. If |forceClose| is false the event handler, if any, will be
49-
/// allowed to prompt the user and the user can optionally cancel the close.
50-
/// If |force_close| is true the prompt will not be displayed and the close
51-
/// will proceed. Results in a call to CefLifeSpanHandler::DoClose() if the
52-
/// event handler allows the close or if |force_close| is true. See
53-
/// CefLifeSpanHandler::DoClose() documentation for additional usage
54-
/// information.
55-
/// </summary>
47+
/// Request that the browser close. The JavaScript 'onbeforeunload' event will be fired.
48+
/// </summary>
49+
/// <param name="forceClose">
50+
/// If forceClose is false the event handler, if any, will be allowed to prompt the user and the
51+
/// user can optionally cancel the close. If forceClose is true the prompt will not be displayed
52+
/// and the close will proceed. Results in a call to <see cref="ILifeSpanHandler.DoClose"/> if
53+
/// the event handler allows the close or if forceClose is true
54+
/// See <see cref="ILifeSpanHandler.DoClose"/> documentation for additional usage information.
55+
/// </param>
5656
void CloseBrowser(bool forceClose);
5757

5858
/// <summary>

CefSharp/IBrowserHost.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ public interface IBrowserHost : IDisposable
2121
/// <summary>
2222
/// Add the specified word to the spelling dictionary.
2323
/// </summary>
24-
/// <param name="word"></param>
24+
/// <param name="word">custom word to be added to dictionary</param>
2525
void AddWordToDictionary(string word);
2626

2727
/// <summary>
@@ -66,7 +66,7 @@ public interface IBrowserHost : IDisposable
6666
void DragTargetDragDrop(MouseEvent mouseEvent);
6767

6868
/// <summary>
69-
/// Call this method when the drag operation started by a <see cref="CefSharp.Internals.IRenderWebBrowser.StartDragging"/> call has ended either in a drop or by being cancelled.
69+
/// Call this method when the drag operation started by a <see cref="CefSharp.Internals.IRenderWebBrowser.StartDragging(IDragData, DragOperationsMask, int, int)"/> call has ended either in a drop or by being cancelled.
7070
/// If the web view is both the drag source and the drag target then all DragTarget* methods should be called before DragSource* methods.
7171
/// This method is only used when window rendering is disabled.
7272
/// </summary>
@@ -82,7 +82,7 @@ public interface IBrowserHost : IDisposable
8282
void DragTargetDragLeave();
8383

8484
/// <summary>
85-
/// Call this method when the drag operation started by a <see cref="CefSharp.Internals.IRenderWebBrowser.StartDragging"/> call has completed.
85+
/// Call this method when the drag operation started by a <see cref="CefSharp.Internals.IRenderWebBrowser.StartDragging(IDragData, DragOperationsMask, int, int)"/> call has completed.
8686
/// This method may be called immediately without first calling DragSourceEndedAt to cancel a drag operation.
8787
/// If the web view is both the drag source and the drag target then all DragTarget* methods should be called before DragSource* mthods.
8888
/// This method is only used when window rendering is disabled.

CefSharp/IDragData.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ public interface IDragData : IDisposable
1717
/// <summary>
1818
/// Gets a copy of the current drag data
1919
/// </summary>
20-
/// <returns></returns>
20+
/// <returns>a clone of the current object</returns>
2121
IDragData Clone();
2222

2323
/// <summary>
@@ -124,4 +124,4 @@ public interface IDragData : IDisposable
124124
/// </summary>
125125
bool IsDisposed { get; }
126126
}
127-
}
127+
}

CefSharp/IFrame.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -195,6 +195,8 @@ public interface IFrame : IDisposable
195195
///
196196
/// The request object will be marked as read-only after calling this method.
197197
/// </summary>
198+
/// <param name="request">the web request</param>
199+
/// <param name="client">the client</param>
198200
IUrlRequest CreateUrlRequest(IRequest request, IUrlRequestClient client);
199201
}
200202
}

0 commit comments

Comments
 (0)